Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an example of artifact store #276

Merged
merged 13 commits into from
Aug 16, 2024
Merged

Conversation

nabenabe0928
Copy link
Collaborator

Motivation

This example adds an example of artifact store.

Description of the changes

  • Add an example
  • Add the test to yaml

Copy link
Collaborator Author

@nabenabe0928 nabenabe0928 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@not522 Could you review this PR?

@nabenabe0928 nabenabe0928 self-assigned this Aug 5, 2024
@nabenabe0928 nabenabe0928 added the document Documentation related. label Aug 5, 2024
@not522 not522 assigned not522 and unassigned nabenabe0928 Aug 5, 2024
@not522
Copy link
Member

not522 commented Aug 8, 2024

Could you add a description on the beginning of the program like this?

"""
Optuna example that optimizes a simple quadratic function with constraints.
This setup is called `constrained optimization`.
Constrained optimization is useful when we would like to optimize some metrics under
some constraints. For example, we would like to maximize the accuracy of a deep neural networks
while guaranteeing that deep neural networks fit on your hardware, e.g. 8GB of memory consumption.
In this case, constrained optimization aims to yield an optimal solution that satisfied
such constraints.
Note that Optuna cannot optimize an objective that will not return any results when some
constraints violate. For example, when we run a memory-intensive algorithm and user sets
the memory constraint very close to the limit, we may not get any results if the memory constraint
is violated. However, Optuna cannot handle such situations.
Please also check https://optuna.readthedocs.io/en/stable/faq.html#id16 as well.
"""

@nabenabe0928
Copy link
Collaborator Author

@not522
I merged the main branch and addressed your comment!
Could you please take another look?

basic/artifact_store.py Outdated Show resolved Hide resolved
@nabenabe0928
Copy link
Collaborator Author

I addressed your comment:) @not522

Copy link
Member

@not522 not522 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@not522 not522 merged commit ecc3e42 into optuna:main Aug 16, 2024
7 checks passed
@not522 not522 added this to the v4.0.0 milestone Aug 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
document Documentation related.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants